home *** CD-ROM | disk | FTP | other *** search
/ Utilities Professional 1-1500 / Utilities Professional 1-1500 (1994)(WPD)[!].iso / 12511500 / var1464.dms / var1464.adf / amicon_docs.lha / function.doc < prev    next >
Text File  |  1992-01-26  |  12KB  |  383 lines
  1.     The following list are all the fucntions available to use in AMICON, There
  2.  will be more comming as soon as there done.
  3.  
  4.  Number  : 0
  5.  Parems  : T or nothing
  6.  Function: LOGGOFF
  7.  
  8.    Logs user off, It T is supplied it will display the logout text first, If
  9.  no parems are supplied then the user is Instantly logged of the system.
  10.  
  11.             --------------------------------------------
  12.  
  13.  Number  : 1
  14.  Parems  : <PATH:FILENAME>,0
  15.  Function: DISPLAY TEXT FILE WITHOUT CLS
  16.  
  17.    This function displays the text file supplied within the parems, if a 
  18.  parem is not supplied then the user may select the name of a text file he/she
  19.  wishes to display
  20.  
  21.    When putting the filename in, you can use a wild card. This allows the BBS
  22.  to determine wether to display the .txt or .ans text file. To use the 
  23.  wildcard you would leave out the .ans or .txt. The Wildcard is used as this,
  24.  
  25.    Text filename is - NEWUSER.txt or NEWUSER.ANS
  26.    Wildcard would be NEWUSER#?
  27.  
  28.    The BBS wouyld add the .txt or .ans for you, depending on what display mode
  29.  the user is using.
  30.  
  31.            --------------------------------------------- 
  32.  
  33.  Number  : 2
  34.  Parems  : <PATH:FILENAME>,0
  35.  Function: CLS SCREEN FIRST THEN DISPLAY TEXT FILE.
  36.  
  37.   Function 2 is exactly the same as function 1, with the exception it will
  38.  clear the screen first before displaying the text file.
  39.  
  40.     The wildcard explained in fucntion 1, may be used for this function as
  41.   well.
  42.  
  43.            --------------------------------------------- 
  44.  
  45.  Number  : 3 
  46.  Parems  : none
  47.  Function: SYSOP PAGE
  48.     
  49.    Pages the sysop if the sysop has the pager on, if not the user is told the
  50.  sysop is unavailable at the moment. This function will be enchanced at a 
  51.  later date.
  52.  
  53.            --------------------------------------------- 
  54.  
  55.  Number  : 4
  56.  Parems  : <PATH:FILENAME>
  57.  Function: RUNBACK DOS COMMAND
  58.  
  59.    Executes a dos command, using runback. This allows the command to return
  60.  control back to the BBS immeadiatly. Handy for running a script file when 
  61.  someone logs off.
  62.  
  63.            --------------------------------------------- 
  64.  
  65.  Number  : 5
  66.  Parems  : <PATH:FILENAME>
  67.  Function: EXECUTE DOS COMMAND
  68.  
  69.    Executes a dos command, this function does not runback the command like 
  70.  function 4 does. So it will cause the BBS to halt untill the dos command 
  71.  has finished.
  72.  
  73.            --------------------------------------------- 
  74.  
  75.  Number  : 6 
  76.  Parems  : none
  77.  Function: UPLOAD LOCALLY
  78.  
  79.    Allows the sysop to place files into the file catalogues. At the moment
  80.  the file maust be placed into the particular fileboard by hand first. Then
  81.  the sysop selects this function and answers the questions.
  82.   This function will also be updated later, TO allow a great deal more
  83.  flexability.
  84.  
  85.            --------------------------------------------- 
  86.  
  87.  Number  : 7
  88.  Parems  : none
  89.  Function: LIST ACCESSABLE FILE BOARDS
  90.  
  91.    When selected by the user, this function will display a list of fileboards
  92.  and the access he/she has to them.
  93.    PLEASE NOTE: if you have any fileboards marked as private, then the user
  94.  cannot see them unless they have FULL access to that particular fileboard.
  95.  
  96.     See access levels for more info.
  97.  
  98.            --------------------------------------------- 
  99.  
  100.  Number  : 8
  101.  Parems  : none
  102.  Function: LIST ACCESSABLE MESSAGE BOARDS
  103.  
  104.    Does the same thing as function 7, except this one displays the access to
  105.  message boards that the user has
  106.  
  107.            --------------------------------------------- 
  108.  
  109.  Number  : 9
  110.  Parems  : S,E
  111.  Function: SHOW/EDIT USER STATS
  112.  
  113.   Depending on the parem supplied this function will either
  114.  
  115.    S - Show the online users stats to him, or
  116.    E - Allow the user to edit his stats.
  117.  
  118.        When editing the user may only change the password, location, phone
  119.  number, interests, or computer.
  120.  
  121.            --------------------------------------------- 
  122.  
  123.  Number  : 10
  124.  Parems  : none
  125.  Function: DISPLY TIME STATUS
  126.  
  127.    Shows the user what time they logged in, their time limit, how long they
  128.  have been online and the amount of online time they have left.
  129.  
  130.            --------------------------------------------- 
  131.  
  132.  Number  : 11
  133.  Parems  : <KEY>
  134.  Function: WAIT FOR A KEY TO BE PRESSED
  135.  
  136.    Waits for the key supplied in parems to be pressed, Not much use on its
  137.  own. But with function 13 it can be pretty usefull.
  138.  
  139.            --------------------------------------------- 
  140.  
  141.  Number  : 12
  142.  Parems  : <MENUNAME>
  143.  Function: GOTO ANOTHER MENU
  144.  
  145.    Switches to the menu supplied in parems. NOTE - you do not add the .TXT
  146.  or .ANS suffix, this is handled by AMICON and depends wether the users
  147.  display is text or ansi.
  148.  
  149.            --------------------------------------------- 
  150.  
  151.  Number  : 13
  152.  Parems  : <STRING>
  153.  Function: DISPLAYS A LINE OF TEXT
  154.  
  155.    Displays the line of text in parems. Usefull if linked with function 11.
  156.  
  157.            --------------------------------------------- 
  158.  
  159.  Number  : 15
  160.  Parems  : none
  161.  Function: DISPLAY CALLER LOG
  162.  
  163.   Displays the days caller log to the user.
  164.  
  165.            --------------------------------------------- 
  166.  
  167.  Number  : 16
  168.  Parems  : D,S
  169.  Function: DISPLAY/SEARCH USER-LIST
  170.  
  171.     Displays or searches the user list. If <S>earch is selected the user will
  172.  be asked what they want to search on.
  173.  
  174.            --------------------------------------------- 
  175.  
  176.  Number  : 17
  177.  Parems  : none
  178.  Function: CHANGE MENU SETS
  179.  
  180.    Allows the user to switch between text or Ansi menus.
  181.   YOUR text menus may be duplicates of the ansi menus if you want, as AMICON
  182.   automatically strips any colour commands out when displaying text. BUT it
  183.   wont strip out cursor positioning commands.
  184.  
  185.            --------------------------------------------- 
  186.  
  187.  Number  : 18
  188.  Parems  : none
  189.  Function: REDISPLAY CURRENT MENU
  190.  
  191.    Redisplays the current menu the user is on.
  192.  
  193.            --------------------------------------------- 
  194.  
  195.  Number  : 19
  196.  Parems  : <NAME>,0 or none
  197.  Function: LEAVE EMAIL
  198.  
  199.    Leave an email message to the person specified in parems. If 0 or nothing
  200.  is specified then AMICON will ask the user who they want to leave EMAIL to.
  201.  
  202.            --------------------------------------------- 
  203.  
  204.  Number  : 20
  205.  Parems  : G,<SECTION NUMBER>
  206.  Function: CATALOGUE FILES
  207.  
  208.    Displays the file catalogue for a given area. If G is specified then the
  209.  function will catalogue all section the user has access to.
  210.  IF a section number is specified then the function will only catalogue that
  211.  particular section.
  212.  
  213.            --------------------------------------------- 
  214.  
  215.  Number  : 21
  216.  Parems  : G,<SECTION NUMBER>
  217.  Function: SCAN FOR NEW FILES
  218.  
  219.   Displays all new files uploaded since the callers last scan. Again if G
  220.  is specified then the scan is global, if a section number is supplied then
  221.  only that section is scanned.
  222.  
  223.            --------------------------------------------- 
  224.  
  225.  Number  : 22
  226.  Parems  : G,<SECTION>,NONE
  227.  Function: FIND A FILE
  228.  
  229.   Searches through a given fileboard for the file entered by the user.
  230.   - If G is supplied then the search is GLOBAL
  231.   - If a section number is supplied then only that section is searched
  232.   - If no parems are supplied then the user is asked to enter a section to
  233.       search or select a global scan.
  234.  
  235.            --------------------------------------------- 
  236.  
  237.  Number  : 23
  238.  Parems  : NONE
  239.  Function: SCAN UPLOAD HELD DIRECTORY
  240.  
  241.     This is a sysop only function. When files are uploaded they are checked 
  242.   to see if a duplicate exists in ANY OTHER fileboards. If one does the user
  243.   is informed and the file moved to FBOARDS:FILEBOARD_41. It is left there
  244.   until you move it online or delete it. 
  245.     This fuction simply lets you scan the files in the held directory. You
  246.   will be informed on the wait screen if any exist.
  247.  
  248.            --------------------------------------------- 
  249.  
  250.  Number  : 24
  251.  Parems  : NONE
  252.  Function: SCAN CLOSED UPLOAD DIRECTORY
  253.  
  254.     Another sysop only function. Same principal as function 23, except this
  255.   function scans the closed upload directory. Only of any use if you actually
  256.   have a closed upload directory. Again you will be informed on the wait 
  257.   screen if any files are actually in the directory.
  258.  
  259.            --------------------------------------------- 
  260.  
  261.  Number  : 25
  262.  Parems  : <PATH:FILENAME>
  263.  Function: DIRECT DOWNLOAD
  264.  
  265.    Allows the user to do a direct download that is specifeid in the parems,
  266.   Direct downloads are free, so the users download stats will not be credited
  267.   with the details of the download.
  268.  
  269.            --------------------------------------------- 
  270.  
  271.  Number  : 26
  272.  Parems  : <SECTION>,NONE
  273.  Function: UPLOAD FILE(s)
  274.  
  275.    Upload function, If a section is specified then the user will automatically
  276.  upload to this section.
  277.  If no section is specified then the user is asked which fileboard to upload
  278.  to, they can also bring up a list of fileboards they have access to.
  279.  
  280.            --------------------------------------------- 
  281.  
  282.  Number  : 27
  283.  Parems  : NONE
  284.  Function: SWITCH BETWEEN FILE LISTING TYPES.
  285.  
  286.     Switches the user between Long file lists and short file lists. Whatever
  287.   option the user has set when they log off, will be saved and defaulted to
  288.   on their next call. Users may also change between the two lists by editing
  289.   their own account with the Online user-editor.
  290.  
  291.            --------------------------------------------- 
  292.  
  293.  Number  : 29
  294.  Parems  : NONE
  295.  Function: READ MARKED MAIL
  296.  
  297.     Allows the user to read any mail that is waiting in their marked mail 
  298.   list. If a users does not unmark the messages as they read them, then the
  299.   messages will remain marked.
  300.  
  301.            --------------------------------------------- 
  302.  Number  : 30
  303.  Parems  : <SECTION>,G
  304.  Function: NEW MAIL SCAN
  305.  
  306.    Scans the messages bases for any new mail since the user last read them.
  307.    If G is specified then the scan is global dependant on the users access
  308.  to particular message boards.
  309.    If a section number is supplied then only that section is scanned.
  310.  
  311.            --------------------------------------------- 
  312.  
  313.  Number  : 31
  314.  Parems  : <SECTION>
  315.  Function: LEAVE NORMAL MESSAGE
  316.  
  317.    Normal here means a message that is not a PRIVATE EMAIL MESSAGE. Section
  318.    number must be supplied along with the function.
  319.  
  320.            --------------------------------------------- 
  321.  
  322.  Number  : 32
  323.  Parems  : <SECTION>
  324.  Function: READ NORMAL MAIL
  325.  
  326.   Normal mail means any mail which is not PRIVATE EMAIL. Section number must
  327.  be supplied for the funtion to work. The user will be placed into the p
  328.  particular section at the last message they read.
  329.  
  330.            --------------------------------------------- 
  331.  
  332.  Number  : 50
  333.  Parems  : <PATH:FILENAME>
  334.  Function: EXECUTE A PARAGON DOOR
  335.  
  336.    Executes an external paragon door using the inbuilt paragon door handler.
  337.   You should find the door handler is 100% compatable with Paragon doors.
  338.  
  339.            --------------------------------------------- 
  340.  
  341.  Number  : 51
  342.  Parems  : <PATH:FILENAME>
  343.  Function: AMICON CONTROLL DOOR
  344.  
  345.     This is a NEW function and is not fully implemented yet.
  346.    When done it will be another door port. BUT its specifically designed for
  347.   With AMICON in mind. Eventually all my editors will run through this door
  348.   port instead of being built in. Why does it need to be a function ???
  349.     Well when the port is fully finished i will be releasing the code for
  350.   creating your own door, along with all the commands available. Meaning 
  351.   you will be able to write your own doors and maybe even rewrite my editors
  352.   and use your own. Also you could easily add new functions to the BBS
  353.   through this port.
  354.  
  355.            --------------------------------------------- 
  356.  
  357.  Number  : 52
  358.  Parems  : <PATH:FILENAME PAREMS>
  359.  Function: RUN A CLI COMMAND & SEND ITS OUTPUT TO THE SERIAL/LOCAL SCREEN
  360.  
  361.     This function will run a cli command and send its output to the serial 
  362.   and to the locall screen. At the moment it can only run commands that do
  363.   not need any keypresses once the've been run. IE - DIR,STATUS etc.
  364.   DO NOT RUN ANYTHING THAT NEEDS INPUT ONCE RUN OR IT WILL HANG THE SYSTEM,
  365.   the ability to do this will be added at a later date.
  366.  
  367.             --------------------------------------------
  368.  
  369.  
  370.  
  371. end
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.